using System;

namespace Synergy.Web.UI.WebControls.WebParts
{
	/// <summary>
	/// Indicates the virtual path of a user control to be used within a <see cref="UserControlWebPart"/>.
	/// </summary>
	/// <remarks>
	///		<list type="table">
	///			<listheader><term>Version</term><description>Description</description></listheader>
	///			<item>
	///				<term>1.0</term>
	///				<description>Initial version</description>
	///			</item>
	///		</list>
	/// </remarks>
	[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
	public sealed class UserControlAttribute : Attribute
	{
		/// <summary>
		/// Initializes a new instance of the <see cref="UserControlAttribute"/> class.
		/// </summary>
		/// <param name="virtualPath">The virtual path.</param>
		public UserControlAttribute(string virtualPath)
		{
			VirtualPath = virtualPath;
		}


		/// <summary>
		/// Gets or sets the virtual path.
		/// </summary>
		/// <value>The virtual path.</value>
		public string VirtualPath { get; private set; }
	}
}